do not optimize docusaurus build #880
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@ffakenz could you double check what I changed here? I'm considering that, either we're on master or not so I don't generate documentation twice, once for stable and once for unstable. But, honestly, I have no idea what impact it may have in the way we publish our doc. Did I break something? |
Transactions CostsSizes and execution budgets for Hydra protocol transactions. Note that unlisted parameters are currently using
Script summary
Cost of Init Transaction
Cost of Commit TransactionCurrently only one UTxO per commit allowed (this is about to change soon)
Cost of CollectCom Transaction
Cost of Close Transaction
Cost of Contest Transaction
Cost of Abort TransactionSome variation because of random mixture of still initial and already committed outputs.
Cost of FanOut TransactionInvolves spending head output and burning head tokens. Uses ada-only UTxO for better comparability.
|
pgrange
force-pushed
the
doc_faster
branch
5 times, most recently
from
a472ca1 to
67905d3
Compare
pgrange
changed the title
ch1bo
reviewed
May 22, 2023
There was a problem hiding this comment.
The premise of this work is very much what I thought we fix about this workflow:
- keep sanity checking of docs separate from actually creating the website, effectively using the fastest, complete build for CI
- move the building of the website into the
https://github.com/input-output-hk/hydra/actions/workflows/publish-docs.yamlworkflow- not using artifacts, but just building it twice whenever we need it built
- that is, push on
masterand push onreleasebranches for example
Instead of trying to optimize a conceptionally fragile workflow, I would suggest to move to a more robust approach first and by that, eliminate slow CI by design?
ch1bo
reviewed
May 23, 2023
ch1bo
approved these changes
May 24, 2023
We do not optimize docusaurus build when not on master or release. We only want to sanity chack the doc and the links but do not plan to ever publish this doc. Not optimizing saves minutes. In case we're building for master or release, then, we optimize. Also, we did not need both stable/unstable versions for master so we only build the doc once.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Documentation step was taking several minutes to optimize a web-site we will, most of the time, never publish. And, also, it was doing it twice sometimes.
So we do not generate documentation twice anymore. Also, we only generate optimized documentation for branch master and release. For all the other branches, we keep building the docusaurus stuff but only for sanity check so we don't optimize and we don't upload the artifact either.
To check that this P.R. did not break with the Publish Docs workflow, one can check this run which contains an artifact that you can download to check locally (spoiler alert: it still works): https://github.com/input-output-hk/hydra/actions/runs/5047620832